GNSS 26 Click Driver

API for configuring and manipulating GNSS 26 Click driver. More...

Topics
	GNSS 26 Device Settings
	Settings for registers of GNSS 26 Click driver.
	GNSS 26 MikroBUS Map
	MikroBUS pin mapping of GNSS 26 Click driver.

Functions
void	gnss26_cfg_setup (gnss26_cfg_t *cfg)
	GNSS 26 configuration object setup function.
void	gnss26_drv_interface_sel (gnss26_cfg_t *cfg, gnss26_drv_t drv_sel)
	GNSS 26 driver interface setup function.
err_t	gnss26_init (gnss26_t *ctx, gnss26_cfg_t *cfg)
	GNSS 26 initialization function.
err_t	gnss26_generic_write (gnss26_t *ctx, uint8_t *data_in, uint16_t len)
	GNSS 26 data writing function.
err_t	gnss26_generic_read (gnss26_t *ctx, uint8_t *data_out, uint16_t len)
	GNSS 26 data reading function.
uint8_t	gnss26_get_pps_pin (gnss26_t *ctx)
	GNSS 26 get PPS pin function.
void	gnss26_set_rst_pin (gnss26_t *ctx, uint8_t state)
	GNSS 26 set RST pin function.
void	gnss26_reset_device (gnss26_t *ctx)
	GNSS 26 reset device function.
err_t	gnss26_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
	GNSS 26 parse GGA function.

Detailed Description

API for configuring and manipulating GNSS 26 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

gnss26_cfg_setup()

void gnss26_cfg_setup

(

gnss26_cfg_t *

cfg

)

GNSS 26 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See gnss26_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

gnss26_drv_interface_sel()

void gnss26_drv_interface_sel	(	gnss26_cfg_t *	cfg,
		gnss26_drv_t	drv_sel )

GNSS 26 driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters

[out]	cfg	: Click configuration structure. See gnss26_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See gnss26_drv_t object definition for detailed explanation.

Returns

Nothing.

Note

This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

gnss26_generic_read()

err_t gnss26_generic_read	(	gnss26_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

GNSS 26 data reading function.

This function reads a desired number of data bytes by using UART or I2C serial interface.

Parameters

[in]	ctx	: Click context object. See gnss26_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

• >0 - Number of data bytes read,
• <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note

None.

gnss26_generic_write()

err_t gnss26_generic_write	(	gnss26_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

GNSS 26 data writing function.

This function writes a desired number of data bytes by using UART or I2C serial interface.

Parameters

[in]	ctx	: Click context object. See gnss26_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss26_get_pps_pin()

uint8_t gnss26_get_pps_pin

(

gnss26_t *

ctx

)

GNSS 26 get PPS pin function.

This function returns the pulse per second (PPS) pin logic state.

Parameters

[in]

ctx

: Click context object. See gnss26_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

gnss26_init()

err_t gnss26_init	(	gnss26_t *	ctx,
		gnss26_cfg_t *	cfg )

GNSS 26 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See gnss26_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See gnss26_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss26_parse_gga()

err_t gnss26_parse_gga	(	uint8_t *	rsp_buf,
		uint8_t	gga_element,
		uint8_t *	element_data )

GNSS 26 parse GGA function.

This function parses the GGA data from the read response buffer.

Parameters

[in]	rsp_buf	: Response buffer.
[in]	gga_element	: GGA element position [1-14].
[out]	element_data	: Element data parsed.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss26_reset_device()

void gnss26_reset_device

(

gnss26_t *

ctx

)

GNSS 26 reset device function.

This function resets the device by toggling the RST pin.

Parameters

[in]

ctx

: Click context object. See gnss26_t object definition for detailed explanation.

Returns

None.

Note

None.

gnss26_set_rst_pin()

void gnss26_set_rst_pin	(	gnss26_t *	ctx,
		uint8_t	state )

GNSS 26 set RST pin function.

This function sets the RST pin logic state.

Parameters

[in]	ctx	: Click context object. See gnss26_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.